<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>mipicsiss: xmipi_menu.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">mipicsiss
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xmipi__menu_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xmipi_menu.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This is the main header file for the Xilinx Menu implementation as used in the MIPI example design. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who    Date     Changes
</p>
<hr/>
<p>
1.00  pg    12/07/17 Initial release.
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mipi___menu_config.html">XMipi_MenuConfig</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The MIPI menu configuration.  <a href="struct_x_mipi___menu_config.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mipi___menu.html">XMipi_Menu</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The MIPI menu instance data.  <a href="struct_x_mipi___menu.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a7a0fcb0f82e2e662239f22f7ba80c4b0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmipi__menu_8h.html#a7a0fcb0f82e2e662239f22f7ba80c4b0">XMIPI_MENU_H_</a></td></tr>
<tr class="memdesc:a7a0fcb0f82e2e662239f22f7ba80c4b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent circular inclusions by using protection macros.  <a href="#a7a0fcb0f82e2e662239f22f7ba80c4b0">More...</a><br/></td></tr>
<tr class="separator:a7a0fcb0f82e2e662239f22f7ba80c4b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ad152a71eec6c6e938d9dc27638785eb3"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmipi__menu_8h.html#ad152a71eec6c6e938d9dc27638785eb3">XMipi_MenuType</a> </td></tr>
<tr class="memdesc:ad152a71eec6c6e938d9dc27638785eb3"><td class="mdescLeft">&#160;</td><td class="mdescRight">The MIPI menu types.  <a href="xmipi__menu_8h.html#ad152a71eec6c6e938d9dc27638785eb3">More...</a><br/></td></tr>
<tr class="separator:ad152a71eec6c6e938d9dc27638785eb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:af0db91312e15cacbd685acc33f8bfbe4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmipi__menu_8h.html#af0db91312e15cacbd685acc33f8bfbe4">XMipi_MenuInitialize</a> (<a class="el" href="struct_x_mipi___menu.html">XMipi_Menu</a> *InstancePtr, u32 UartBaseAddress)</td></tr>
<tr class="memdesc:af0db91312e15cacbd685acc33f8bfbe4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function takes care of the MIPI menu initialization.  <a href="#af0db91312e15cacbd685acc33f8bfbe4">More...</a><br/></td></tr>
<tr class="separator:af0db91312e15cacbd685acc33f8bfbe4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9a8f7bf04b219aa044a98795614f300"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmipi__menu_8h.html#af9a8f7bf04b219aa044a98795614f300">XMipi_MenuProcess</a> (<a class="el" href="struct_x_mipi___menu.html">XMipi_Menu</a> *InstancePtr)</td></tr>
<tr class="memdesc:af9a8f7bf04b219aa044a98795614f300"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is called to trigger the MIPI menu state machine.  <a href="#af9a8f7bf04b219aa044a98795614f300">More...</a><br/></td></tr>
<tr class="separator:af9a8f7bf04b219aa044a98795614f300"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ba9a6b6dd08002647c9c9311d98c3d1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmipi__menu_8h.html#a1ba9a6b6dd08002647c9c9311d98c3d1">XMipi_MenuReset</a> (<a class="el" href="struct_x_mipi___menu.html">XMipi_Menu</a> *InstancePtr)</td></tr>
<tr class="memdesc:a1ba9a6b6dd08002647c9c9311d98c3d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function resets the menu to the main menu.  <a href="#a1ba9a6b6dd08002647c9c9311d98c3d1">More...</a><br/></td></tr>
<tr class="separator:a1ba9a6b6dd08002647c9c9311d98c3d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac06ed3176952d39fe028b9b13cdcbc38"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmipi__menu_8h.html#ac06ed3176952d39fe028b9b13cdcbc38">InitImageProcessingPipe</a> (void)</td></tr>
<tr class="memdesc:ac06ed3176952d39fe028b9b13cdcbc38"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Initializes Image Processing blocks wrt to selected resolution.  <a href="#ac06ed3176952d39fe028b9b13cdcbc38">More...</a><br/></td></tr>
<tr class="separator:ac06ed3176952d39fe028b9b13cdcbc38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9698d142e2ca5e8ef2fc0a39521abdb2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmipi__menu_8h.html#a9698d142e2ca5e8ef2fc0a39521abdb2">DisableImageProcessingPipe</a> (void)</td></tr>
<tr class="memdesc:a9698d142e2ca5e8ef2fc0a39521abdb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function disables Demosaic, GammaLut and VProcSS IPs.  <a href="#a9698d142e2ca5e8ef2fc0a39521abdb2">More...</a><br/></td></tr>
<tr class="separator:a9698d142e2ca5e8ef2fc0a39521abdb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a757a75677d4ddc9b3d14e2f4f3f0332c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmipi__menu_8h.html#a757a75677d4ddc9b3d14e2f4f3f0332c">CamReset</a> (void)</td></tr>
<tr class="memdesc:a757a75677d4ddc9b3d14e2f4f3f0332c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function resets IMX274 camera sensor.  <a href="#a757a75677d4ddc9b3d14e2f4f3f0332c">More...</a><br/></td></tr>
<tr class="separator:a757a75677d4ddc9b3d14e2f4f3f0332c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27ae0b7f949e11fb7e55c2fe3fda88d5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmipi__menu_8h.html#a27ae0b7f949e11fb7e55c2fe3fda88d5">Reset_IP_Pipe</a> (void)</td></tr>
<tr class="memdesc:a27ae0b7f949e11fb7e55c2fe3fda88d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function resets image processing pipe.  <a href="#a27ae0b7f949e11fb7e55c2fe3fda88d5">More...</a><br/></td></tr>
<tr class="separator:a27ae0b7f949e11fb7e55c2fe3fda88d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a7a0fcb0f82e2e662239f22f7ba80c4b0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XMIPI_MENU_H_</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Prevent circular inclusions by using protection macros. </p>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ad152a71eec6c6e938d9dc27638785eb3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xmipi__menu_8h.html#ad152a71eec6c6e938d9dc27638785eb3">XMipi_MenuType</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The MIPI menu types. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a757a75677d4ddc9b3d14e2f4f3f0332c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CamReset </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function resets IMX274 camera sensor. </p>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a class="anchor" id="a9698d142e2ca5e8ef2fc0a39521abdb2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void DisableImageProcessingPipe </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function disables Demosaic, GammaLut and VProcSS IPs. </p>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a class="anchor" id="ac06ed3176952d39fe028b9b13cdcbc38"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void InitImageProcessingPipe </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Initializes Image Processing blocks wrt to selected resolution. </p>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="pipeline__program_8c.html#a21ee37887dab63622f890ae50ffaccee">ConfigCSC()</a>, <a class="el" href="pipeline__program_8c.html#a5cc10afcf20d68eb7ad335b5a6ef4c13">ConfigDemosaic()</a>, and <a class="el" href="pipeline__program_8c.html#aa251d18c526e8bb62900891757ee18fb">ConfigGammaLut()</a>.</p>

<p>Referenced by <a class="el" href="xmipi__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="a27ae0b7f949e11fb7e55c2fe3fda88d5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Reset_IP_Pipe </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function resets image processing pipe. </p>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a class="anchor" id="af0db91312e15cacbd685acc33f8bfbe4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XMipi_MenuInitialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_mipi___menu.html">XMipi_Menu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>UartBaseAddress</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function takes care of the MIPI menu initialization. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_mipi___menu.html" title="The MIPI menu instance data. ">XMipi_Menu</a> instance. </td></tr>
    <tr><td class="paramname">UartBaseAddress</td><td>points to the base address of PS uart.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>Referenced by <a class="el" href="xmipi__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="af9a8f7bf04b219aa044a98795614f300"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XMipi_MenuProcess </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_mipi___menu.html">XMipi_Menu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is called to trigger the MIPI menu state machine. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_mipi___menu.html" title="The MIPI menu instance data. ">XMipi_Menu</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>Referenced by <a class="el" href="xmipi__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="a1ba9a6b6dd08002647c9c9311d98c3d1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XMipi_MenuReset </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_mipi___menu.html">XMipi_Menu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function resets the menu to the main menu. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_mipi___menu.html" title="The MIPI menu instance data. ">XMipi_Menu</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
